Flask官方文档¶

本内为Flask官方文档
本文有配套Flask视频课程，详见课程目录
本文配套源代码详见作者博客，麦扣网
Python学习交流QQ群： 999 0960

欢迎阅读 Flask 文档。本文档由很多部分构成。我强烈推荐你们从安装开始，接着可以浏览下快速入门。比起快速入门（快速入门），教程内容更详细一些，该文档介绍了如何创建一个完整（尽管很小）的 Flask 应用。如果你想要深入研究 Flask 的话，可以查看 API 。在 Flask 范例章节中描述一些常见的模式。

Flask 依赖着两个外部库： Jinja2 模板引擎以及 Werkzeug WSGI 工具集。本文档并不包含这两个库的文档，查看它们的文档请移步：

Jinja2 文档
Werkzeug 文档

1. 前言
- 1.1. 什么是 “微”？
- 1.2. 配置和约定
- 1.3. 与 Flask 共同成长
2. 给经验丰富的程序员的前言
- 2.1. Flask 中的本地线程
- 2.2. 小心翼翼地进行 Web 开发
- 2.3. Python 3 的状况
3. 安装
- 3.1. virtualenv
- 3.2. 全局安装
- 3.3. 体验最新的 Flask (Living on the Edge)
- 3.4. Windows 下的 pip 和 distribute
4. 快速入门
- 4.1. 一个最小的应用
- 4.2. 调试模式
- 4.3. 路由
- 4.4. 静态文件
- 4.5. 渲染模板
- 4.6. 接收请求数据
- 4.7. 重定向和错误
- 4.8. 关于响应
- 4.9. 会话
- 4.10. 消息闪烁
- 4.11. 日志
- 4.12. 整合 WSGI 中间件
- 4.13. 部署到 Web 服务器
5. 教程
- 5.1. 介绍 Flaskr
- 5.2. Step 0: 创建文件夹
- 5.3. Step 1: 数据库模式
- 5.4. Step 2: 应用设置代码
- 5.5. Step 3: 创建数据库
- 5.6. Step 4: 请求数据库连接
- 5.7. Step 5: 视图函数
- 5.8. Step 6: 模版
- 5.9. Step 7: 添加样式
- 5.10. 福利: 测试应用
6. 模版
- 6.1. Jinja 配置
- 6.2. 标准上下文
- 6.3. 标准过滤器
- 6.4. 控制自动转义
- 6.5. 注册过滤器
- 6.6. 上下文处理器
7. 测试 Flask 应用
- 7.1. 应用程序
- 7.2. 测试骨架
- 7.3. 第一个测试
- 7.4. 登录和注销
- 7.5. 测试添加消息
- 7.6. 其它测试技巧
- 7.7. 伪造资源和上下文
- 7.8. 保持上下文
- 7.9. 访问和修改会话
8. 记录应用程序错误
- 8.1. 错误邮件
- 8.2. 记录到一个文件中
- 8.3. 控制日志格式
- 8.4. 其它的库
9. 调试应用程序错误
- 9.1. 有疑问时，手动运行
- 9.2. 使用调试器
10. 配置处理
- 10.1. 基本配置
- 10.2. 内置的配置值
- 10.3. 从文件中配置
- 10.4. 配置最佳实践
- 10.5. 开发/生产
- 10.6. 示例文件夹
11. 信号
- 11.1. 订阅信号
- 11.2. 创建信号
- 11.3. 发送信号
- 11.4. 信号与 Flask 的请求上下文
- 11.5. 基于信号订阅的装饰器
- 11.6. 核心信号
12. 插拨式视图
- 12.1. 基本规则
- 12.2. 方法提示
- 12.3. 基于调度的方法
- 12.4. 装饰视图
- 12.5. 用于 APIs 的方法视图
13. 应用上下文
- 13.1. 应用上下文目的
- 13.2. 创建一个应用上下文
- 13.3. 应用上下文的局部变量
- 13.4. 应用上下文的用法
14. 请求上下文
- 14.1. 深入与上下文本地变量
- 14.2. 上下文如何工作
- 14.3. 回调和错误
- 14.4. 销毁回调
- 14.5. 代理注意事项
- 14.6. 错误时上下文保存
15. 用蓝图实现模块化应用
- 15.1. 为什么用蓝图？
- 15.2. 蓝图的概念
- 15.3. 第一个蓝图
- 15.4. 注册蓝图
- 15.5. 蓝图资源
- 15.6. 构建 URLs
16. Flask 扩展
- 16.1. 查找扩展
- 16.2. 使用扩展
- 16.3. Flask 0.8 以前的 Flask
17. 在 Shell 中使用 Flask
- 17.1. 创建一个请求上下文
- 17.2. 在请求之前/之后使用 shell
- 17.3. 进一步提升 Shell 体验
18. Flask 范例
- 18.1. 大型应用
  - 18.1.1. 简单的包
  - 18.1.2. 使用蓝图
- 18.2. 应用工厂
  - 18.2.1. 基础工厂
  - 18.2.2. 使用应用
  - 18.2.3. 改进工厂
- 18.3. 应用调度
  - 18.3.1. 说明
  - 18.3.2. 组合应用
  - 18.3.3. 根据子域调度
  - 18.3.4. 根据路径调度
- 18.4. 实现 API 异常
  - 18.4.1. 简单的异常类
  - 18.4.2. 注册一个错误处理器
  - 18.4.3. 视图中的用法
- 18.5. URL 处理器
  - 18.5.1. 国际化的应用 URL
  - 18.5.2. 国际化的蓝图 URL
- 18.6. 使用 Distribute 部署
  - 18.6.1. 基础设置脚本
  - 18.6.2. 分发资源
  - 18.6.3. 声明依赖
  - 18.6.4. 安装 / 开发
- 18.7. 使用 Fabric 部署
  - 18.7.1. 创建第一个 Fabfile
  - 18.7.2. 运行 Fabfile
  - 18.7.3. WSGI 文件
  - 18.7.4. 配置文件
  - 18.7.5. 第一次部署
  - 18.7.6. 下一步
- 18.8. 在 Flask 中使用 SQLite 3
  - 18.8.1. 按需连接
  - 18.8.2. 简化查询
  - 18.8.3. 初始化模式
- 18.9. 在 Flask 中使用 SQLAlchemy
  - 18.9.1. Flask-SQLAlchemy 扩展
  - 18.9.2. 声明
  - 18.9.3. 人工对象关系映射
  - 18.9.4. SQL 抽象层
- 18.10. 上传文件
  - 18.10.1. 简介
  - 18.10.2. 改进上传
  - 18.10.3. 上传进度条
  - 18.10.4. 一个更简便的方案
- 18.11. 缓存
  - 18.11.1. 设置一个缓存
  - 18.11.2. 使用缓存
- 18.12. 视图装饰器
  - 18.12.1. 检查登录装饰器
  - 18.12.2. 缓存装饰器
  - 18.12.3. 模板装饰器
  - 18.12.4. 端点装饰器
- 18.13. 使用 WTForms 进行表单验证
  - 18.13.1. 表单
  - 18.13.2. 视图
  - 18.13.3. 模板中的表单
- 18.14. 模板继承
  - 18.14.1. 基础模板
  - 18.14.2. 子模板
- 18.15. 消息闪现
  - 18.15.1. 简单的例子
  - 18.15.2. 闪现消息的类别
  - 18.15.3. 过滤闪现消息
- 18.16. 用 jQuery 实现 Ajax
  - 18.16.1. 加载 jQuery
  - 18.16.2. 我的站点在哪?
  - 18.16.3. JSON 视图函数
  - 18.16.4. HTML 部分
- 18.17. 自定义出错页面
  - 18.17.1. 常见出错代码
  - 18.17.2. 出错处理器
- 18.18. 惰性载入视图
  - 18.18.1. 转换为集中 URL 映射
  - 18.18.2. 延迟载入
- 18.19. 在 Flask 中使用 MongoKit
  - 18.19.1. 声明
  - 18.19.2. PyMongo 兼容层
- 18.20. 添加一个页面图标
  - 18.20.1. 另见
- 18.21. 数据流
  - 18.21.1. 基本使用
  - 18.21.2. 在模板中生成流
- 18.22. 延迟请求回调
  - 18.22.1. 装饰器
  - 18.22.2. 调用延迟函数
  - 18.22.3. 一个实际应用的例子
- 18.23. 添加 HTTP Method Overrides
- 18.24. 请求内容校验
- 18.25. 基于后台作业的 Celery
  - 18.25.1. 安装 Celery
  - 18.25.2. 配置 Celery
  - 18.25.3. 小型例子
  - 18.25.4. 运行 Celery Worker
19. 部署方式
- 19.1. mod_wsgi (Apache)
- 19.2. 独立 WSGI 容器
- 19.3. uWSGI
  - 19.3.1. 使用 uwsgi 启动你的应用
  - 19.3.2. 配置 nginx
- 19.4. FastCGI
- 19.5. CGI
  - 19.5.1. 创建一个 .cgi 文件
  - 19.5.2. 服务器配置
20. 大型应用
- 20.1. 阅读源代码
- 20.2. 挂接，扩展
- 20.3. 继承
- 20.4. 用中间件包装
- 20.5. 派生
- 20.6. 专家级的伸缩性
- 20.7. 与社区沟通
21. API
- 21.1. 应用对象
- 21.2. 蓝图对象
- 21.3. 传入请求数据
- 21.4. 响应对象
- 21.5. 会话
- 21.6. 会话接口
- 21.7. 测试客户端
- 21.8. 应用全局变量
- 21.9. 有用的函数和类
- 21.10. 消息闪现
- 21.11. JSON 支持
- 21.12. 渲染模版
- 21.13. 配置
- 21.14. 扩展
- 21.15. 流辅助函数
- 21.16. 有用的内部函数
- 21.17. 信号
- 21.18. 基于类的视图
- 21.19. URL 路由注册
- 21.20. 视图函数选项
22. Flask 中的设计决策
- 22.1. 显式的应用对象
- 22.2. 路由系统
- 22.3. 某个模板引擎
- 22.4. 微与依赖
- 22.5. 线程局域变量
- 22.6. Flask 是什么，不是什么？
23. HTML/XHTML 常见问题
- 23.1. XHTML 的历史
- 23.2. HTML5 的历史
- 23.3. HTML 对 XHTML
- 23.4. “严格”意味着什么？
- 23.5. HTML5 中的新技术
- 23.6. 应该使用什么？
24. 安全注意事项
- 24.1. 跨站脚本攻击（XSS）
- 24.2. 跨站请求伪造（CSRF）
- 24.3. JSON 安全
25. Flask 中的 Unicode
- 25.1. 自动转换
- 25.2. 金科玉律
- 25.3. 自行编解码
- 25.4. 配置编辑器
26. Flask 扩展开发
- 26.1. 剖析扩展
- 26.2. “Hello Flaskext!”
  - 26.2.1. setup.py
  - 26.2.2. flask_sqlite3.py
- 26.3. 初始化扩展
- 26.4. 扩展的代码
- 26.5. 使用 _app_ctx_stack
- 26.6. 销毁行为
- 26.7. 他山之玉，可以攻石
- 26.8. 已审核的扩展
- 26.9. 扩展导入的过渡
27. Pocoo 风格指引
- 27.1. 总体布局
- 27.2. 表达式和语句
- 27.3. 命名约定
- 27.4. 文档字符串
- 27.5. 注释
28. Python 3 支持
- 28.1. 要求
- 28.2. API 稳定性
- 28.3. 用户少
- 28.4. 小生态系统
- 28.5. 建议
29. Upgrading to Newer Releases
- 29.1. Version 0.10
- 29.2. Version 0.9
- 29.3. Version 0.8
- 29.4. Version 0.7
- 29.5. Version 0.6
- 29.6. Version 0.5
- 29.7. Version 0.4
- 29.8. Version 0.3
30. 许可证
- 30.1. 作者
- 30.2. 通用许可证定义
- 30.3. Flask 许可证
- 30.4. Flask 插图许可证